Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pluginfy RuboCop Rails #1434

Merged
merged 1 commit into from
Feb 15, 2025
Merged

Pluginfy RuboCop Rails #1434

merged 1 commit into from
Feb 15, 2025

Conversation

koic
Copy link
Member

@koic koic commented Feb 4, 2025

This PR adds support for RuboCop's Plugin feature.

It replaces the ad-hoc Inject with RuboCop plugins introduced in RuboCop 1.72.

NOTE: Version 1.72.1 or later is specified, as it includes rubocop/rubocop#13837, which removes the Inject from spec_helper.rb. While 1.72.0 is sufficient for runtime, but specifying the patch version 1.72.1 keeps things simple.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@koic koic force-pushed the pluginfy_with_lint_roller branch 4 times, most recently from 90a085d to f7479f9 Compare February 11, 2025 14:50
@koic koic force-pushed the pluginfy_with_lint_roller branch 3 times, most recently from 0e23cab to 3cf929e Compare February 15, 2025 12:34
This PR adds support for RuboCop's Plugin feature:
rubocop/rubocop#13792

It replaces the ad-hoc `Inject` with RuboCop plugins introduced in RuboCop 1.72.

NOTE: Version 1.72.1 or later is specified, as it includes rubocop/rubocop#13837,
which removes the `Inject` from spec_helper.rb. While 1.72.0 is sufficient for runtime,
but specifying the patch version 1.72.1 keeps things simple.
@koic koic force-pushed the pluginfy_with_lint_roller branch from 3cf929e to aeb3cac Compare February 15, 2025 16:02
@koic koic merged commit 897b22b into rubocop:master Feb 15, 2025
16 checks passed
@koic koic deleted the pluginfy_with_lint_roller branch February 15, 2025 16:39
koic added a commit to koic/rubocop-rails that referenced this pull request Feb 16, 2025
This PR fixes an incorrect behavior when using `AllCops: MigratedSchemaVersion`.

This suppresses the following warning when `MigratedSchemaVersion` is defined on the user side:

```console
$ bundle exec rubocop
(snip)

Warning: AllCops does not support MigratedSchemaVersion parameter.

Supported parameters are:

  - RubyInterpreters
  - Include
  - Exclude
  - DefaultFormatter
  - DisplayCopNames
  - DisplayStyleGuide
  - StyleGuideBaseURL
  - DocumentationBaseURL
  - DocumentationExtension
  - ExtraDetails
  - StyleGuideCopsOnly
  - EnabledByDefault
  - DisabledByDefault
  - NewCops
  - UseCache
  - MaxFilesInCache
  - CacheRootDirectory
  - AllowSymlinksInCacheRootDirectory
  - TargetRubyVersion
  - ParserEngine
  - SuggestExtensions
  - ActiveSupportExtensionsEnabled
  - StringLiteralsFrozenByDefault
```

The default value of `AllCops: MigratedSchemaVersion` in `config/default.yml` will change from `null` to the UNIX epoch time,
but typically, there should be no migration files older than the UNIX epoch time.

This is a bug fix related to the plugin migration in rubocop#1434.
koic added a commit to koic/rubocop-rails that referenced this pull request Feb 16, 2025
This PR fixes an incorrect behavior when using `AllCops: MigratedSchemaVersion`.

This suppresses the following warning when `MigratedSchemaVersion` is defined on the user side:

```console
$ bundle exec rubocop
(snip)

Warning: AllCops does not support MigratedSchemaVersion parameter.

Supported parameters are:

  - RubyInterpreters
  - Include
  - Exclude
  - DefaultFormatter
  - DisplayCopNames
  - DisplayStyleGuide
  - StyleGuideBaseURL
  - DocumentationBaseURL
  - DocumentationExtension
  - ExtraDetails
  - StyleGuideCopsOnly
  - EnabledByDefault
  - DisabledByDefault
  - NewCops
  - UseCache
  - MaxFilesInCache
  - CacheRootDirectory
  - AllowSymlinksInCacheRootDirectory
  - TargetRubyVersion
  - ParserEngine
  - SuggestExtensions
  - ActiveSupportExtensionsEnabled
  - StringLiteralsFrozenByDefault
```

The default value of `AllCops: MigratedSchemaVersion` in `config/default.yml` will change from `null` to the UNIX epoch time,
but typically, there should be no migration files older than the UNIX epoch time.

This is a bug fix related to the plugin migration in rubocop#1434.
koic added a commit that referenced this pull request Feb 18, 2025
Since #1434 made RuboCop 1.72+ a runtime requirement, `cop_enabled?` can now be used.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant